csapi.h

Go to the documentation of this file.

/*********************************************************************
 *
 *           Copyright (c) 2021 by Visuality Systems, Ltd.
 *
 *********************************************************************
 * FILE NAME     : $Workfile:$
 * ID            : $Header:$
 * REVISION      : $Revision:$
 *--------------------------------------------------------------------
 * DESCRIPTION   : CIFS Server Interface
 *--------------------------------------------------------------------
 * MODULE        : NQ
 * DEPENDENCIES  :
 ********************************************************************/

#ifndef _CSAPI_H_
#define _CSAPI_H_

#include "cmapi.h"

#if defined(UD_NQ_INCLUDECIFSSERVER) || defined(DOXYGEN)

NQ_STATUS csStart(void);

void csStop(void);

NQ_INT csAddShareA(const NQ_CHAR * name, const NQ_CHAR * path, NQ_BOOL printQueue, const NQ_CHAR * comment, const NQ_CHAR * reserved);

NQ_INT csAddShare(const NQ_WCHAR * name, const NQ_WCHAR * path, NQ_BOOL printQueue, const NQ_WCHAR * comment, const NQ_CHAR * reserved);

NQ_INT csRemoveShareA(const NQ_CHAR * name);

NQ_INT csRemoveShare(const NQ_WCHAR* name);

#if defined(UD_NQ_INCLUDESMB3) || defined(DOXYGEN)

NQ_INT csSetShareEncryptionA(const NQ_CHAR * name, NQ_BOOL isEncrypted);

NQ_INT csSetShareEncryption(const NQ_WCHAR * name, NQ_BOOL isEncrypted);

#endif /* UD_NQ_INCLUDESMB3 */

typedef struct {
#ifdef CM_NQ_STORAGE
    NQ_CHAR   fileNamePath[CM_BUFFERLENGTH(NQ_CHAR, SY_MAXFILENAMELEN)];    
#else
    NQ_CHAR   fileNamePath[CM_BUFFERLENGTH(NQ_CHAR, UD_FS_FILENAMELEN)];    
#endif
    NQ_CHAR   userName[CM_BUFFERLENGTH(NQ_CHAR, CM_USERNAMELENGTH)];        
    NQ_CHAR   IP [CM_BUFFERLENGTH(NQ_CHAR, CM_IPADDR_MAXLEN)];              
    NQ_BOOL   isDirectory;                                                  
}FileDataA_t;

typedef struct {
#ifdef CM_NQ_STORAGE
    NQ_WCHAR  fileNamePath[CM_BUFFERLENGTH(NQ_WCHAR, SY_MAXFILENAMELEN)];    
#else
    NQ_WCHAR  fileNamePath[CM_BUFFERLENGTH(NQ_WCHAR, UD_FS_FILENAMELEN)];    
#endif
    NQ_WCHAR  userName[CM_BUFFERLENGTH(NQ_WCHAR, CM_USERNAMELENGTH)];       
    NQ_WCHAR  IP [CM_BUFFERLENGTH(NQ_WCHAR, CM_IPADDR_MAXLEN)];             
    NQ_BOOL   isDirectory;                                                  
} CSFileData;

NQ_BOOL csEnumerateOpenFilesA(NQ_UINT index, FileDataA_t *fileData);

NQ_BOOL csEnumerateOpenFiles(NQ_UINT index, CSFileData *fileData);

NQ_STATUS csCleanUserServerConnectionsA(const NQ_CHAR *name, NQ_BOOL isDomainUser);

NQ_STATUS csCleanUserServerConnections(const NQ_WCHAR *name, NQ_BOOL isDomainUser);

void csSetAnonymousAllowed(NQ_BOOL on);

#if defined(UD_NQ_INCLUDEEVENTLOG) || defined(DOXYGEN)

typedef struct {
    NQ_WCHAR userName[256];                 
    NQ_WCHAR shareName[UD_FS_MAXSHARELEN];  
    NQ_IPADDRESS ip;                        
    NQ_BOOL ipc;                            
    NQ_BOOL printQueue;                     
} EVCSShareConnectionEntry;

typedef struct {
    NQ_WCHAR userName[256];                 
#ifndef CM_NQ_STORAGE
    NQ_WCHAR fileName[UD_FS_FILENAMELEN];   
#else
    NQ_WCHAR fileName[SY_MAXFILENAMELEN];   
#endif
    NQ_WCHAR shareName[UD_FS_MAXSHARELEN];  
    NQ_IPADDRESS ip;                        
    NQ_UINT16 access;                       
} EVCSOpenFileEntry;

NQ_COUNT evcsEnumerateConnectedShares(NQ_COUNT maxEntries, EVCSShareConnectionEntry* buffer);

NQ_COUNT evcsEnumerateOpenFiles(NQ_COUNT maxEntries, EVCSOpenFileEntry* buffer);

#endif /* UD_NQ_INCLUDEEVENTLOG */
#endif /* UD_NQ_INCLUDECIFSSERVER */
#endif  /* _CSAPI_H_ */